Delete Service

This request removes a service from the Live Platform.

URI

Copy
{{baseUrl}}/api/v2/customer/{CustomerId}

HTTP Method

DELETE

Request Parameter

Parameter

Type

Description

CustomerId

string

Id value created in the Live Platformcustomer tenant SQL database directory:

Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Customer from Lead Overview). If this field is null, a license has not yet been applied to the lead.
Direct Routing: A new Hosted Essentials service is created by Create Essentials Customer.

See Get Services Brief Details (V3) to retrieve the Customer Id. Search the results of this request for your customer ShortName to find the matching 'Id' value.

This value is also obtained in the 'Get Task' response when the customer is created.

HTTP Responses

200 OK: 1 Indicates a successful deletion. Run endpoint Get Customers to confirm.
404 Not Found: Example below showing a customer that is not found:
Copy
"Customer with 3aae7841-12d1-4341-a7f1-867f1dd0ba0c not found"

When you delete a customer, all SBC site locations and Dialplans added for this customer are deleted. Once deleted, verify the following:

In the Multitenant portal Tenants page, verify that the customer has been deleted (see Tenants Global View).
In the Multitenant portal Site Locations page, verify that all the sites have been deleted. For prefixes, click Show Prefixes and Refresh (seeManage SBC Prefixes).
In SBC Web application, verify that all the prefixes have been deleted.